/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.webapi.controller.organisationunit;

import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;

import java.util.ArrayList;
import java.util.List;
import org.hisp.dhis.attribute.AttributeValues;
import org.hisp.dhis.common.OpenApi;
import org.hisp.dhis.commons.filter.FilterUtils;
import org.hisp.dhis.organisationunit.OrganisationUnit;
import org.hisp.dhis.organisationunit.OrganisationUnitGroup;
import org.hisp.dhis.organisationunit.OrganisationUnitGroupSet;
import org.hisp.dhis.organisationunit.OrganisationUnitService;
import org.hisp.dhis.system.filter.OrganisationUnitPolygonCoveringCoordinateFilter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author James Chang <jamesbchang@gmail.com>
 */
@OpenApi.Document(
    entity = OrganisationUnit.class,
    classifiers = {"team:platform", "purpose:metadata"})
@Controller
@RequestMapping("/api/organisationUnitLocations")
public class OrganisationUnitLocationController {

  private static final String ORGUNIGROUP_SYMBOL = "orgUnitGroupSymbol";

  @Autowired private OrganisationUnitService organisationUnitService;

  /** Get Organisation Units within a distance from a location */
  @GetMapping(
      value = "/withinRange",
      produces = {"*/*", APPLICATION_JSON_VALUE})
  @ResponseBody
  public List<OrganisationUnit> getEntitiesWithinRange(
      @RequestParam Double longitude,
      @RequestParam Double latitude,
      @RequestParam Double distance,
      @RequestParam(required = false) String orgUnitGroupSetId) {
    List<OrganisationUnit> entityList =
        new ArrayList<>(
            organisationUnitService.getOrganisationUnitWithinDistance(
                longitude, latitude, distance));

    for (OrganisationUnit organisationUnit : entityList) {
      if (orgUnitGroupSetId != null) {
        AttributeValues attributeValues = AttributeValues.empty();
        for (OrganisationUnitGroup organisationUnitGroup : organisationUnit.getGroups()) {
          for (OrganisationUnitGroupSet orgunitGroupSet : organisationUnitGroup.getGroupSets()) {
            if (orgunitGroupSet.getUid().compareTo(orgUnitGroupSetId) == 0) {
              attributeValues =
                  attributeValues.added(ORGUNIGROUP_SYMBOL, organisationUnitGroup.getSymbol());
            }
          }
        }
        organisationUnit.setAttributeValues(attributeValues);
      } else {
        organisationUnit.setAttributeValues(AttributeValues.empty());
      }
      // Clear out all data not needed for this task

      organisationUnit.removeAllDataSets();
      organisationUnit.removeAllUsers();
      organisationUnit.removeAllOrganisationUnitGroups();
    }

    return entityList;
  }

  /** Get lowest level Org Units that includes the location in their polygon shape. */
  @GetMapping(
      value = "/orgUnitByLocation",
      produces = {"*/*", APPLICATION_JSON_VALUE})
  @ResponseBody
  public List<OrganisationUnit> getParentByLocation(
      @RequestParam Double longitude,
      @RequestParam Double latitude,
      @RequestParam(required = false) String topOrgUnit,
      @RequestParam(required = false) Integer targetLevel) {
    List<OrganisationUnit> entityList =
        new ArrayList<>(
            organisationUnitService.getOrganisationUnitByCoordinate(
                longitude, latitude, topOrgUnit, targetLevel));

    // Remove unrelated details and output in JSON format

    for (OrganisationUnit organisationUnit : entityList) {
      organisationUnit.setAttributeValues(AttributeValues.empty());
      organisationUnit.removeAllDataSets();
      organisationUnit.removeAllUsers();
      organisationUnit.removeAllOrganisationUnitGroups();
    }

    return entityList;
  }

  /** Check if the location lies within the organisation unit boundary */
  @GetMapping(
      value = "/locationWithinOrgUnitBoundary",
      produces = {"*/*", APPLICATION_JSON_VALUE})
  @ResponseBody
  public boolean checkLocationWithinOrgUnit(
      @RequestParam String orgUnitUid,
      @RequestParam Double longitude,
      @RequestParam Double latitude) {
    boolean withinOrgUnit = false;

    List<OrganisationUnit> organisationUnits = new ArrayList<>();
    organisationUnits.add(organisationUnitService.getOrganisationUnit(orgUnitUid));
    FilterUtils.filter(
        organisationUnits,
        new OrganisationUnitPolygonCoveringCoordinateFilter(longitude, latitude));

    if (!organisationUnits.isEmpty()) {
      withinOrgUnit = true;
    }

    return withinOrgUnit;
  }
}
